/*
 * Copyright 2012 Raimon Rodriguez
 * 
 * This file is part of sgfx.
 * 
 * sgfx is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * sgfx is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with sgfx. If not, see <http://www.gnu.org/licenses/>.
 */

package com.googlecode.sgfx.base;

import java.awt.Cursor;

/**
 * This class provides convenience methods to obtain predefined cursors in a more concise way and
 * save some boilerplate code.
 *
 * @author raimon.rodriguez
 * @see Cursor
 */
public final class Cursors {

    private Cursors() {}

    
    /**
     * <p>
     * Returns the system's crosshair cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR);
     * </code>
     *
     * @return the system's crosshair cursor
     * @see Cursor#CROSSHAIR_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getCrosshairCursor() {
        return Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR);
    }

    /**
     * <p>
     * Returns the system's east-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.E_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's east-resize cursor
     * @see Cursor#E_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getEastResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.E_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's hand cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.HAND_CURSOR);
     * </code>
     *
     * @return the system's hand cursor
     * @see Cursor#HAND_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getHandCursor() {
        return Cursor.getPredefinedCursor(Cursor.HAND_CURSOR);
    }

    /**
     * <p>
     * Returns the system's move cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR);
     * </code>
     *
     * @return the system's move cursor
     * @see Cursor#MOVE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getMoveCursor() {
        return Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's north-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.N_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's north-resize cursor
     * @see Cursor#N_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getNorthResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.N_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's north-east-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.NE_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's north-east-resize cursor
     * @see Cursor#NE_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getNorthEastResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.NE_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's north-west-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.NW_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's north-west-resize cursor
     * @see Cursor#NW_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getNorthWestResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.NW_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's south-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.S_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's south-resize cursor
     * @see Cursor#S_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getSouthResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.S_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's south-east-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.SE_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's south-east-resize cursor
     * @see Cursor#SE_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getSouthEastResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.SE_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's south-west-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.SW_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's north-west-resize cursor
     * @see Cursor#SW_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getSouthWestResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.SW_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's text cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.TEXT_CURSOR);
     * </code>
     *
     * @return the system's text cursor
     * @see Cursor#TEXT_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getTextCursor() {
        return Cursor.getPredefinedCursor(Cursor.TEXT_CURSOR);
    }

    /**
     * <p>
     * Returns the system's west-resize cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.W_RESIZE_CURSOR);
     * </code>
     *
     * @return the system's west-resize cursor
     * @see Cursor#W_RESIZE_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getWestResizeCursor() {
        return Cursor.getPredefinedCursor(Cursor.W_RESIZE_CURSOR);
    }

    /**
     * <p>
     * Returns the system's wait cursor. This method invocation is equivalent to:
     * </p>
     * <code>
     * Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR);
     * </code>
     *
     * @return the system's wait cursor
     * @see Cursor#WAIT_CURSOR
     * @see Cursor#getPredefinedCursor(int)
     */
    public static Cursor getWaitCursor() {
        return Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR);
    }
}
